home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / CHFLZ100.ZIP / README.TXT < prev   
Text File  |  1996-09-05  |  7KB  |  155 lines
  1.  
  2. README FILE FOR CHIEFLZ v1.00
  3. -----------------------------
  4.  
  5. This package contains ready-to-compile-and-run Borland Pascal and
  6. Delphi sources for LZSS (LZ77) compression. The original source for
  7. the LZSS compression was called LZSSUNIT. This package develops that
  8. unit further. Although the package is called "CHIEFLZ", it is the joint
  9. work of The African Chief (Dr. Abimbola Adeleke Olowofoyeku), and Chris
  10. Rankin. Most of the Win32 (Delphi 2.x) sources were written by Chris
  11. Rankin, who also ported all the 16-bit ASM code in the original
  12. LZSSUNIT.PAS (LZSS16.PAS in this package) to 32-bit ASM for Delphi 2.x
  13. (LZSS32.PAS). That was a great effort: many thanks to Chris!
  14.  
  15. This package does not contain too much in the way of documentation. The
  16. existing documentation consists of this file, the comments in the source
  17. code, and a test program (LZ.PAS or LZ.DPR). The test program is sufficient
  18. to show how to use the routines in this package.
  19.  
  20.  
  21. Distribution
  22. ------------
  23. This package is released as FREEWARE. This means that it is FREE, but it
  24. is NOT public domain software. Dr A Olowofoyeku and Chris Rankin retain
  25. full copyright in all the source files, except LZSS16.PAS (which is
  26. original to someone else).
  27.  
  28. You may freely use these routines in your own programs. You may freely
  29. redistribute this package, on the conditions;
  30.    [a] that the whole package is redistributed, AND,
  31.    [b] that NO alteration is made to the package, or to any of the files
  32.        in it, AND,
  33.    [c] that no charge (other than charges for disk duplication and
  34.        handling, in any case, not exceeding $5.00 (US) or equivalent)
  35.        be made for any redistribution.
  36.  
  37. Bulletin boards and CD-ROM producers make freely distribute this package,
  38. subject to the above conditions.
  39.  
  40.  
  41. ***************
  42. **** NOTE:*****
  43. ***************
  44. All use of this package is SUBJECT TO THE DISCLAIMER AT THE END OF THIS
  45. FILE.
  46.  
  47.  
  48. Features
  49. --------
  50. 1. Compiles for all Borland Pascal platforms (DOS, DOS DPMI, Win16, and
  51.    Win32).
  52. 2. Functions can be statically linked into programs.
  53. 3. Functions can be (for DOS DPMI, Win16 and Win32) compiled into a DLL.
  54. 4. Import units for (implicit and explicit) DLL use.
  55. 5. Compresses and Decompresses single files.
  56. 6. Compiles several files into an archive, and dearchives this.
  57. 7. Returns the contents of Chief LZ archives.
  58. 8. Stores (for Win16 and Win32) version information from Windows binaries.
  59. 9. Pascal object and Delphi class to encapsulate the functionality of the
  60.    package (cannot be exported from the DLL).
  61.  
  62.  
  63. Exported routines
  64. -----------------
  65. Below is a simple list of the routines exported by the ChiefLZ
  66. package (unit and/or DLL).
  67.  
  68. 1. Single File Compression
  69. --------------------------
  70. *  function  LZCompress               - compress single file
  71. *  function  LZDecompress             - decompress single file
  72. *  function  LZCompressEx             - compress single file
  73. *  function  LZDeCompressEx           - decompress single file
  74. *  function  IsChiefLZFile            - is it a ChiefLZ file?
  75.  
  76.  
  77. 2. Compression into LZ Archives
  78. -------------------------------
  79. *  function  LZArchive                - archive some files
  80. *  function  LZDeArchive              - dearchive a ChiefLZ archive
  81. *  function  IsChiefLZArchive         - is it a ChiefLZ archive?
  82. *  function  GetChiefLZFileName       - get filename from inside LZ file
  83. *  function  GetChiefLZFileSize       - get real size from inside LZ file
  84. *  function  GetChiefLZArchiveSize    - get real size of Archive
  85. *  function  GetChiefLZArchiveInfo    - return info in archive header
  86. *  function  GetFullLZName            - return a file name from LZ archive
  87.  
  88.  
  89. 3. DLL routines
  90. ---------------
  91. *  function  ChiefLZDLLVersion        - return version of LZ DLL
  92. *  function  GetLZMarkerChar          - get marker for LZ file extension
  93. *  procedure SetLZMarkerChar          - set marker for LZ file extension
  94.  
  95.  
  96.  
  97. File List
  98. ---------
  99. 1.  CHFTYPES.PAS    -  assorted data types used by the package
  100. 2.  CHFUTILS.PAS    -  assorted shared functions and procedures
  101. 3.  CHIEFLZ.PAS     -  the main "Chief" LZ unit (can be compiled to a DLL)
  102. 4.  LZ.DPR          -  test program (for Delphi 1.x and Delphi 2.x)
  103. 5.  LZ.PAS          -  test program (for BPW, TPW, TP7 - same as LZ.DPR)
  104. 6.  LZDEFINE.INC    -  assorted conditional defines
  105. 7.  LZEXPLIC.PAS    -  unit for explicitly loading the LZ DLL
  106. 8.  LZIMPLIC.PAS    -  unit for implicitly loading the LZ DLL
  107. 9.  LZSS16.PAS      -  the 16-bit LZSS compression algorithm
  108. 10. LZSS32.PAS      -  the 32-bit LZSS compression algorithm
  109. 11. LZ_CONST.PAS    -  some constants (Win32)
  110. 12. LZ_CONST.RC     -  string table for messages (Win32)
  111. 13. LZ_CONST.RES    -  string table resources (Win32)
  112. 14. LZ_DLL.PAS      _  some constants for DLL use (Win32)
  113. 15. LZ_DLL.RC       -  string table for messages (Win32)
  114. 16. LZ_DLL.RES      -  string table resources (Win32)
  115. 17. LZ_LINK.PAS     _  more constants for DLL use (Win32)
  116. 18. LZ_LINK.RC      _  more constants for DLL use (Win32)
  117. 19. LZ_LINK.RES     _  more constants for DLL use (Win32)
  118. 20. README.TXT      -  this file
  119. 21. FILE_ID.DIZ     -  description file for BBS use
  120.  
  121.  
  122.  
  123. !! Please note the disclaimers below !!
  124.  
  125.     DISCLAIMER
  126.     ----------
  127.     WE DO NOT WARANTEE ANYTHING CONCERNING ANY OF THE SOURCES OR FILES
  128.     WHICH MAKE UP THIS CHIEFLZ PACKAGE. WE ACCEPT NO RESPONSIBILITY FOR
  129.     ANY LOSS OR DAMAGE OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, LOSSES
  130.     OF A PHYSICAL, MENTAL, SOCIAL, FINANCIAL, MARITAL, OR OF WHATEVER
  131.     NATURE, RESULTING FROM THE USE, OR THE PURPORTED USE, OF THIS CHIEFLZ
  132.     PACKAGE OR ANY OF THE FILES IN THE PACKAGE, FOR ANY PURPOSE WHATSOEVER.
  133.     WE DO NOT EVEN WARANTEE THAT THE FILES WILL NOT KILL YOU.
  134.  
  135.     YOU USE THIS CHIEFLZ PACKAGE ENTIRELY AT YOUR OWN RISK, AND YOU SUPPLY
  136.     IT TO YOUR CUSTOMERS, FRIENDS, FAMILY, ACQUAINTANCES, OR ENEMIES,
  137.     ENTIRELY AT YOUR OWN RISK.
  138.  
  139.     IF THESE TERMS ARE NOT ACCEPTABLE TO YOU, THEN PLEASE DELETE ALL
  140.     THE FILES FROM YOUR DISKS IMMEDIATELY AND PERMANENTLY.
  141.  
  142.  
  143.     In this disclaimer, "WE" refers to:
  144.     Dr. A Olowofoyeku, and Chris Rankin
  145.  
  146.  
  147. ---------------------------------------------------------------
  148. September 1996.
  149. Dr. Abimbola Adeleke Olowofoyeku (The African Chief)
  150. Email:  laa12@cc.keele.ac.uk
  151. http://ourworld.compuserve.com/homepages/African_Chief/chief.htm
  152. ----------------------------------------------------------------
  153.  
  154.  
  155.